package jxerializeml.clues.fields;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Defines additional informations to the field, which will help
 * users with modifying the serialized object.
 * 
 * @author Tomáš Zíma
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface SetComment {
	/**
	 * @return
	 *     Text description of the field, comment or something like
	 *     that. It's also possible to create a new line by using
	 *     metacharacter '\n'.
	 */
	public String description();
}
